<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Dynamic Filter Parameter Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">DynamicFilterParameter Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Defines a dynamic filter parameter.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Dynamic Filter Parameter</td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>XML Element:</td>
<td><code>dynamic-filter-parameter</code></td></tr>
<tr><td>Extends:</td>
<td><a href="AbstractScalarParameter.html">AbstractScalarParameter</a></td></tr>
<tr><td>Extendable:</td>
<td>Yes</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>Parameters</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-column">column</a></dt>
<dd>Refers to the data set column.</dd>
<dt><a href="#Property-displayType">displayType</a></dt>
<dd>The display type for the parameter.</dd>
<dt><a href="#Property-filterOperator">filterOperator</a></dt>
<dd>Contains a set of operators.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="AbstractScalarParameter.html#Property-dataSetName">dataSetName</a>, 
<a href="AbstractScalarParameter.html#Property-dataType">dataType</a>, 
<a href="AbstractScalarParameter.html#Property-defaultValue">defaultValue</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="AbstractScalarParameter.html#Property-distinct">distinct</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="Parameter.html#Property-helpText">helpText</a>, 
<a href="Parameter.html#Property-helpTextID">helpTextID</a>, 
<a href="Parameter.html#Property-hidden">hidden</a>, 
<a href="AbstractScalarParameter.html#Property-isRequired">isRequired</a>, 
<a href="AbstractScalarParameter.html#Property-labelExpr">labelExpr</a>, 
<a href="AbstractScalarParameter.html#Property-listLimit">listLimit</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="Parameter.html#Property-promptText">promptText</a>, 
<a href="Parameter.html#Property-promptTextID">promptTextID</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="AbstractScalarParameter.html#Property-selectionList">selectionList</a>, 
<a href="AbstractScalarParameter.html#Property-sortBy">sortBy</a>, 
<a href="AbstractScalarParameter.html#Property-sortByColumn">sortByColumn</a>, 
<a href="AbstractScalarParameter.html#Property-sortDirection">sortDirection</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="AbstractScalarParameter.html#Property-valueExpr">valueExpr</a>, 
<a href="AbstractScalarParameter.html#Property-valueType">valueType</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Inherited Methods</h3>

<p class="section-text">
<a href="Parameter.html#Method-validate">validate</a></p>
<h3>Description</h3>

<div class="section-text">
<p>This element supports dynamic ad hoc parameter feature.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-column">column Property</a></h2>

<p class="section-text">Refers to the data set column.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>Yes</td></tr>
<tr><td>Display Name:</td>
<td>Column</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Refers to the data set column.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-displayType">displayType Property</a></h2>

<p class="section-text">The display type for the parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (dynamicFilterChoice)</td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Display type</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>simple</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>simple</td>
<td>Simple</td>
<td>simple</td>
<td>simple type.</td></tr>
<tr><td>advanced</td>
<td>Advanced</td>
<td>advanced</td>
<td>advanced type.</td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>Identifies it is a simple filter or advanced filter.</p></div>

<hr>
<h2><a name="Property-filterOperator">filterOperator Property</a></h2>

<p class="section-text">Contains a set of operators.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#list">list</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Filter operator</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Contains a set of operators.</p></div>
</body>
</html>
